home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / linklist / source.lha / doc / lInfoNode.3 < prev    next >
Text File  |  1993-08-08  |  1KB  |  51 lines
  1. '.so tmac.clman
  2. .TH "lInfoNode"
  3. .IX lInfoNode
  4. .SH NAME
  5. lInfoNode - Get information about node.
  6. .SH SYNOPSIS
  7. int
  8. .BR "lInfoNode" "(id, which, size, flag)"
  9. .br
  10. .RT
  11. .RP
  12. In    int    id    identifier of linked list
  13. .RP
  14. In    int    which    which node must be inspected
  15. .RP
  16. Out    int    *size    size of data of node
  17. .RP
  18. Out    int    *flag    user information flag
  19. .DT
  20. .SH DESCRIPTION
  21. \fBlInfoNode\fP returns some information about a node. The size of
  22. the data of the node (\fIsize\fP) and the user information flag
  23. (\fIflag\fP). Of which node the information must be given can be
  24. specified by \fIwhich\fP. The first node, the current node, the node
  25. before or after the current node and the node at the end of the list
  26. can be inspected.
  27. .br
  28. Backward retrieving is only possible for doubly linked list. A previous
  29. node can't be inspected for singly linked lists.
  30. .SH PARAMETER DEFINITIONS
  31. .if t .ta 0.2i 1.5i
  32. \fIwhich\fP :
  33. .nf
  34.     lFIRST    first node
  35.     lPREVIOUS    previous node
  36.     lCURRENT    current node
  37.     lNEXT    next node
  38.     lLAST    last node
  39. .fi
  40. .SH RETURN CODES
  41. .nf
  42. Return on success :
  43.     lSUCCESS
  44. Return on error :
  45. .fi
  46. .in +0.2i
  47. lUNKNOWN_ID, lEMPTY_LIST, lWRONG_WHICH, lEOL, lNOT_DOUBLY
  48. .in -0.2i
  49. .SH AUTHOR
  50. Anita Eijs (TNO - Bouw - BouwInformatica)
  51.